docs: Enable vitepress build #1133
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d3xter666
force-pushed
the
feat-create-docsumentation-package
branch
from
037ceae to
31934ec
Compare
d3xter666
force-pushed
the
feat-enable-vitepress
branch
from
8961b0d to
7a2ce4f
Compare
RandomByte
previously requested changes
Oct 13, 2025
d3xter666
force-pushed
the
feat-create-docsumentation-package
branch
from
64066ac to
f3a5128
Compare
d3xter666
force-pushed
the
feat-enable-vitepress
branch
2 times, most recently
from
6afdfe1 to
36c75f1
Compare
d3xter666
force-pushed
the
feat-create-docsumentation-package
branch
from
0107968 to
af5446d
Compare
d3xter666
force-pushed
the
feat-enable-vitepress
branch
from
7d5eba8 to
8beda5d
Compare
d3xter666
force-pushed
the
feat-enable-vitepress
branch
from
c1e36b7 to
a934f2a
Compare
|
|
d3xter666
force-pushed
the
feat-enable-vitepress
branch
from
a934f2a to
c1e36b7
Compare
The CLI page must be generated via the |
d3xter666
force-pushed
the
feat-enable-vitepress
branch
from
d0c7ac3 to
5311640
Compare
|
Remark 1: Remark 2:
Since those files haven't been touched in this PR yet, I couldn't create a GH code suggestion. |
My intention was to do the cleanup in the next step, but now I have fixed the formatting and links. |
matz3
reviewed
Oct 27, 2025
packages/documentation/docs/pages/extensibility/ProjectShims.md
Outdated
Show resolved
Hide resolved
| </script> | ||
|
|
||
| <div style="margin: 1rem 0;"> | ||
| <VPButton class="no-decoration" text="📚 API Reference" href="https://ui5.github.io/cli/v4/api/"/> |
There was a problem hiding this comment.
v4?
I wonder why we can't use relative links here.
There was a problem hiding this comment.
It' should be v5, indeed and I have adjusted it, but It used to be that way so far.
I was trying to just adjust the formatting and eventually something broken/wrong.
Thanks! The formatting should is fine now |
matz3
approved these changes
Oct 28, 2025
d3xter666
added a commit
to d3xter666/ui5-tooling
that referenced
this pull request
Oct 30, 2025
This change continues the efforts from UI5#1132 and enhances it by enabling vitepress build of the documentation. JIRA: CPOUI5FOUNDATION-899 --------- Co-authored-by: Max Reichmann <[email protected]>
d3xter666
added a commit
to d3xter666/ui5-tooling
that referenced
this pull request
Oct 30, 2025
* ci(github-actions): bump actions/setup-node from 5 to 6 (UI5#1163) * docs(README.md): Use stable version in documentation links * Bump actions/stale from 9 to 10 Bumps [actions/stale](https://github.com/actions/stale) from 9 to 10. - [Release notes](https://github.com/actions/stale/releases) - [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md) - [Commits](actions/stale@v9...v10) --- updated-dependencies: - dependency-name: actions/stale dependency-version: '10' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * build(deps-dev): bump koa from 2.16.2 to 2.16.3 Resolves GHSA-g8mr-fgfg-5qpc * docs(README): Fix module overview image Also remove unused UI5 logo image * ci(licensee): Enable licensee check The "only" package uses the MIT license (mentioned in README.md). The license file and license field are missing from the package, but have been added to the GitHub repository: https://github.com/tj/node-only * docs: Minor changes * ci: Add test matrix (Node 20, 22, 24 on Linux / macOS / Windows) Also update checkout action to latest version. * docs: Enable vitepress build (UI5#1133) This change continues the efforts from UI5#1132 and enhances it by enabling vitepress build of the documentation. JIRA: CPOUI5FOUNDATION-899 --------- Co-authored-by: Max Reichmann <[email protected]> * refactor: Create separate package for documentation * refactor: Move /docs to the newly create package * refactor: Guidelines are for the whole project and should be at the top level * refactor: Move /docs to the newly create package * feat: Add vitepress & config * feat: Add gitignore rules for the documentation build * refactor: Make md files vitepress compatible * fix: CLI.md parsing for vitepress * feat: Cleanup documentation (UI5#1135) This PR aims to cleanup redundant files & configurations from the legacy MkDocs build JIRA: CPOUI5FOUNDATION-899 * refactor: Remove unnecessary files from .git * refactor: Enable .git ignore rules after cleanup * refactor: Correct .gitignore rules * refactor: Cleanup redundant configurations * refactor: Use light & dark logos * fix: Restore Guidelines.md * refactor: Use vitepress buttons * refactor: Cleanup * fix: Remove redundant formatting * refactor: Align indexes * refactor: Align indexes * fix: Bad links * fix: Markdowns formatting * fix: Internal links * refactor: Create separate package for documentation * refactor: Move /docs to the newly create package * fix: Adjust paths * feat: Add vitepress & config * refactor: Make md files vitepress compatible * fix: CLI.md parsing for vitepress * feat: Enable GH next docs deployment * refactor: Adjust scripts * fix: Try to run docs properly * fix: Adjust version links * feat: Update alias * docs: Thank you note * refactor: Use Vue buttons, instead of HTML tags * fix: Documentation syntax * refactor: Provide correct base for the documentation * refactor: Update general links to v4 * docs: Update REUSE.toml to reference the vitepress license and contributors * docs: JSDoc cleanup * fix: Address docs CI to the correct branch * docs: Fix index next link * docs: Images for dark and light mode * fix: Provide correct dark logos * fix: Merge conflicts * fix: Merge conflicts * refactor: Adjust config.ts * fix: Rebase missmatches * fix: Add contributors * refactor: Sync packages with main * fix: Merge conflicts --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Florian Vogt <[email protected]> Co-authored-by: Matthias Osswald <[email protected]> Co-authored-by: Max Reichmann <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change continues the efforts from #1132 and enhances it by enabling vitepress build of the documentation.
JIRA: CPOUI5FOUNDATION-899